Skip to content

doc: add comprehensive About section to lib.rs [doc: 3/N] #1291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 13, 2024

Conversation

phip1611
Copy link
Member

@phip1611 phip1611 commented Aug 6, 2024

This is split-out 3/N from #1264 to improve reviewability.

This adds an About section that discusses the value-add and possible use-cases.

Steps to Un-draft

Checklist

  • Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
  • Update the changelog (if necessary)

@phip1611 phip1611 requested a review from nicholasbishop August 6, 2024 15:15
@phip1611 phip1611 marked this pull request as draft August 6, 2024 15:17
@phip1611 phip1611 marked this pull request as ready for review August 9, 2024 08:56
@phip1611 phip1611 marked this pull request as draft August 9, 2024 08:58
@phip1611 phip1611 force-pushed the doc4 branch 2 times, most recently from b4a2d1f to 3e0fa8a Compare August 9, 2024 10:53
@phip1611 phip1611 marked this pull request as ready for review August 9, 2024 10:53
@phip1611
Copy link
Member Author

phip1611 commented Aug 9, 2024

Hm.. I spent much more time on the phrasing of these paragraphs than I'd like to admit 😆 But I think, that the newly written paragraphs are motivating enough so that people use our library.

@phip1611
Copy link
Member Author

Thanks for your input. I think, I came up with something even better. What do youthink?

@phip1611 phip1611 force-pushed the doc4 branch 2 times, most recently from 8fc82a1 to 00f911d Compare August 11, 2024 16:44
@nicholasbishop nicholasbishop added this pull request to the merge queue Aug 13, 2024
Merged via the queue into rust-osdev:main with commit 7eb4b79 Aug 13, 2024
13 checks passed
@phip1611 phip1611 deleted the doc4 branch May 1, 2025 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants